home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1997 October: Mac OS SDK / Dev.CD Oct 97 SDK1.toast / Development Kits (Disc 1) / Interfaces&Libraries / Universal / Interfaces / AIncludes / AppleEvents.a < prev    next >
Encoding:
Text File  |  1997-08-12  |  14.0 KB  |  424 lines  |  [TEXT/MPS ]
  1. ;
  2. ;    File:        AppleEvents.a
  3. ;
  4. ;    Contains:    AppleEvent Package Interfaces.
  5. ;
  6. ;    Version:    Technology:    System 7.5
  7. ;                Release:    Universal Interfaces 3.0.1
  8. ;
  9. ;    Copyright:    © 1989-1997 by Apple Computer, Inc., all rights reserved
  10. ;
  11. ;    Bugs?:        Please include the the file and version information (from above) with
  12. ;                the problem description.  Developers belonging to one of the Apple
  13. ;                developer programs can submit bug reports to:
  14. ;
  15. ;                    devsupport@apple.com
  16. ;
  17. ;
  18.     IF &TYPE('__APPLEEVENTS__') = 'UNDEFINED' THEN
  19. __APPLEEVENTS__ SET 1
  20.  
  21.     IF &TYPE('__TYPES__') = 'UNDEFINED' THEN
  22.     include 'Types.a'
  23.     ENDIF
  24.     IF &TYPE('__MIXEDMODE__') = 'UNDEFINED' THEN
  25.     include 'MixedMode.a'
  26.     ENDIF
  27.     IF &TYPE('__NOTIFICATION__') = 'UNDEFINED' THEN
  28.     include 'Notification.a'
  29.     ENDIF
  30.     IF &TYPE('__EVENTS__') = 'UNDEFINED' THEN
  31.     include 'Events.a'
  32.     ENDIF
  33. ; 
  34. ;    Note:    The functions and types for the building and parsing AppleEvent  
  35. ;            messages has moved to AEDataModel.h
  36. ;
  37.  
  38.     IF &TYPE('__AEDATAMODEL__') = 'UNDEFINED' THEN
  39.     include 'AEDataModel.a'
  40.     ENDIF
  41.  
  42.  
  43.                                                             ; Keywords for Apple event parameters 
  44. keyDirectObject                    EQU        '----'
  45. keyErrorNumber                    EQU        'errn'
  46. keyErrorString                    EQU        'errs'
  47. keyProcessSerialNumber            EQU        'psn '                ; Keywords for special handlers 
  48. keyPreDispatch                    EQU        'phac'                ; preHandler accessor call 
  49. keySelectProc                    EQU        'selh'                ; more selector call 
  50.                                                             ; Keyword for recording 
  51. keyAERecorderCount                EQU        'recr'                ; available only in vers 1.0.1 and greater 
  52.                                                             ; Keyword for version information 
  53. keyAEVersion                    EQU        'vers'                ; available only in vers 1.0.1 and greater 
  54. ;  Event Class 
  55.  
  56. kCoreEventClass                    EQU        'aevt'
  57. ;  Event ID’s 
  58.  
  59. kAEOpenApplication                EQU        'oapp'
  60. kAEOpenDocuments                EQU        'odoc'
  61. kAEPrintDocuments                EQU        'pdoc'
  62. kAEQuitApplication                EQU        'quit'
  63. kAEAnswer                        EQU        'ansr'
  64. kAEApplicationDied                EQU        'obit'
  65. ;  Constants for recording 
  66.  
  67. kAEStartRecording                EQU        'reca'                ; available only in vers 1.0.1 and greater 
  68. kAEStopRecording                EQU        'recc'                ; available only in vers 1.0.1 and greater 
  69. kAENotifyStartRecording            EQU        'rec1'                ; available only in vers 1.0.1 and greater 
  70. kAENotifyStopRecording            EQU        'rec0'                ; available only in vers 1.0.1 and greater 
  71. kAENotifyRecording                EQU        'recr'                ; available only in vers 1.0.1 and greater 
  72.  
  73. ;  parameter to AESend 
  74. ; typedef OptionBits                     AESendOptions
  75.  
  76.  
  77. kAENeverInteract                EQU        $00000010            ; server should not interact with user 
  78. kAECanInteract                    EQU        $00000020            ; server may try to interact with user 
  79. kAEAlwaysInteract                EQU        $00000030            ; server should always interact with user where appropriate 
  80. kAECanSwitchLayer                EQU        $00000040            ; interaction may switch layer 
  81. kAEDontRecord                    EQU        $00001000            ; don't record this event - available only in vers 1.0.1 and greater 
  82. kAEDontExecute                    EQU        $00002000            ; don't send the event for recording - available only in vers 1.0.1 and greater 
  83. kAEProcessNonReplyEvents        EQU        $00008000            ; allow processing of non-reply events while awaiting synchronous AppleEvent reply 
  84. ; typedef SInt32                         AESendMode
  85.  
  86.  
  87. kAENoReply                        EQU        $00000001            ; sender doesn't want a reply to event 
  88. kAEQueueReply                    EQU        $00000002            ; sender wants a reply but won't wait 
  89. kAEWaitReply                    EQU        $00000003            ; sender wants a reply and will wait 
  90. kAEDontReconnect                EQU        $00000080            ; don't reconnect if there is a sessClosedErr from PPCToolbox 
  91. kAEWantReceipt                    EQU        $00000200            ; (nReturnReceipt) sender wants a receipt of message 
  92.  
  93. ;  Constants for timeout durations 
  94.  
  95. kAEDefaultTimeout                EQU        -1                    ; timeout value determined by AEM 
  96. kNoTimeOut                        EQU        -2                    ; wait until reply comes back, however long it takes 
  97.  
  98. ;  priority param of AESend 
  99. ; typedef SInt16                         AESendPriority
  100.  
  101.  
  102. kAENormalPriority                EQU        $00000000            ; post message at the end of the event queue 
  103. kAEHighPriority                    EQU        $00000001            ; post message at the front of the event queue (same as nAttnMsg) 
  104.  
  105. ; typedef SInt8                         AEEventSource
  106.  
  107.  
  108. kAEUnknownSource                EQU        0
  109. kAEDirectCall                    EQU        1
  110. kAESameProcess                    EQU        2
  111. kAELocalProcess                    EQU        3
  112. kAERemoteProcess                EQU        4
  113.  
  114.  
  115.  
  116. ; **************************************************************************
  117. ;  The next couple of calls are basic routines used to create, send,
  118. ;  and process AppleEvents. 
  119. ;*************************************************************************
  120.  
  121. ;
  122. ; pascal OSErr AESend(const AppleEvent *theAppleEvent, AppleEvent *reply, AESendMode sendMode, AESendPriority sendPriority, long timeOutInTicks, AEIdleUPP idleProc, AEFilterUPP filterProc)
  123. ;
  124.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  125.         Macro
  126.         _AESend
  127.             move.w              #$0D17,D0
  128.             dc.w                $A816
  129.         EndM
  130.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  131.         IMPORT_CFM_FUNCTION AESend
  132.     ENDIF
  133.  
  134. ;
  135. ; pascal OSErr AEProcessAppleEvent(const EventRecord *theEventRecord)
  136. ;
  137.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  138.         Macro
  139.         _AEProcessAppleEvent
  140.             move.w              #$021B,D0
  141.             dc.w                $A816
  142.         EndM
  143.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  144.         IMPORT_CFM_FUNCTION AEProcessAppleEvent
  145.     ENDIF
  146.  
  147.  
  148. ;  
  149. ; Note: during event processing, an event handler may realize that it is likely
  150. ; to exceed the client's timeout limit. Passing the reply to this
  151. ; routine causes a wait event to be generated that asks the client
  152. ; for more time. 
  153. ;
  154.  
  155. ;
  156. ; pascal OSErr AEResetTimer(const AppleEvent *reply)
  157. ;
  158.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  159.         Macro
  160.         _AEResetTimer
  161.             move.w              #$0219,D0
  162.             dc.w                $A816
  163.         EndM
  164.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  165.         IMPORT_CFM_FUNCTION AEResetTimer
  166.     ENDIF
  167.  
  168.  
  169. ; **************************************************************************
  170. ;  The following three calls are used to allow applications to behave
  171. ;  courteously when a user interaction such as a dialog box is needed. 
  172. ;*************************************************************************
  173.  
  174.  
  175. ; typedef SInt8                         AEInteractAllowed
  176.  
  177.  
  178. kAEInteractWithSelf                EQU        0
  179. kAEInteractWithLocal            EQU        1
  180. kAEInteractWithAll                EQU        2
  181. ;
  182. ; pascal OSErr AEGetInteractionAllowed(AEInteractAllowed *level)
  183. ;
  184.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  185.         Macro
  186.         _AEGetInteractionAllowed
  187.             move.w              #$021D,D0
  188.             dc.w                $A816
  189.         EndM
  190.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  191.         IMPORT_CFM_FUNCTION AEGetInteractionAllowed
  192.     ENDIF
  193.  
  194. ;
  195. ; pascal OSErr AESetInteractionAllowed(AEInteractAllowed level)
  196. ;
  197.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  198.         Macro
  199.         _AESetInteractionAllowed
  200.             move.w              #$011E,D0
  201.             dc.w                $A816
  202.         EndM
  203.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  204.         IMPORT_CFM_FUNCTION AESetInteractionAllowed
  205.     ENDIF
  206.  
  207. ;
  208. ; pascal OSErr AEInteractWithUser(long timeOutInTicks, NMRecPtr nmReqPtr, AEIdleUPP idleProc)
  209. ;
  210.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  211.         Macro
  212.         _AEInteractWithUser
  213.             move.w              #$061C,D0
  214.             dc.w                $A816
  215.         EndM
  216.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  217.         IMPORT_CFM_FUNCTION AEInteractWithUser
  218.     ENDIF
  219.  
  220.  
  221. ; **************************************************************************
  222. ;  These calls are used to set up and modify the event dispatch table.
  223. ;*************************************************************************
  224.  
  225. ;
  226. ; pascal OSErr AEInstallEventHandler(AEEventClass theAEEventClass, AEEventID theAEEventID, AEEventHandlerUPP handler, long handlerRefcon, Boolean isSysHandler)
  227. ;
  228.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  229.         Macro
  230.         _AEInstallEventHandler
  231.             move.w              #$091F,D0
  232.             dc.w                $A816
  233.         EndM
  234.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  235.         IMPORT_CFM_FUNCTION AEInstallEventHandler
  236.     ENDIF
  237.  
  238. ;
  239. ; pascal OSErr AERemoveEventHandler(AEEventClass theAEEventClass, AEEventID theAEEventID, AEEventHandlerUPP handler, Boolean isSysHandler)
  240. ;
  241.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  242.         Macro
  243.         _AERemoveEventHandler
  244.             move.w              #$0720,D0
  245.             dc.w                $A816
  246.         EndM
  247.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  248.         IMPORT_CFM_FUNCTION AERemoveEventHandler
  249.     ENDIF
  250.  
  251. ;
  252. ; pascal OSErr AEGetEventHandler(AEEventClass theAEEventClass, AEEventID theAEEventID, AEEventHandlerUPP *handler, long *handlerRefcon, Boolean isSysHandler)
  253. ;
  254.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  255.         Macro
  256.         _AEGetEventHandler
  257.             move.w              #$0921,D0
  258.             dc.w                $A816
  259.         EndM
  260.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  261.         IMPORT_CFM_FUNCTION AEGetEventHandler
  262.     ENDIF
  263.  
  264.  
  265. ; **************************************************************************
  266. ; The following four calls are available for applications which need more
  267. ; sophisticated control over when and how events are processed. Applications
  268. ; which implement multi-session servers or which implement their own
  269. ; internal event queueing will probably be the major clients of these
  270. ; routines. They can be called from within a handler to prevent the AEM from
  271. ; disposing of the AppleEvent when the handler returns. They can be used to
  272. ; asynchronously process the event (as MacApp does).
  273. ;*************************************************************************
  274.  
  275. ;
  276. ; pascal OSErr AESuspendTheCurrentEvent(const AppleEvent *theAppleEvent)
  277. ;
  278.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  279.         Macro
  280.         _AESuspendTheCurrentEvent
  281.             move.w              #$022B,D0
  282.             dc.w                $A816
  283.         EndM
  284.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  285.         IMPORT_CFM_FUNCTION AESuspendTheCurrentEvent
  286.     ENDIF
  287.  
  288. ;  
  289. ; Note: The following routine tells the AppleEvent manager that processing
  290. ; is either about to resume or has been completed on a previously suspended
  291. ; event. The procPtr passed in as the dispatcher parameter will be called to
  292. ; attempt to redispatch the event. Several constants for the dispatcher
  293. ; parameter allow special behavior. They are:
  294. ;      - kAEUseStandardDispatch means redispatch as if the event was just
  295. ;      received, using the standard AppleEvent dispatch mechanism.
  296. ;      - kAENoDispatch means ignore the parameter.
  297. ;         Use this in the case where the event has been handled and no
  298. ;      redispatch is needed.
  299. ;      - non nil means call the routine which the dispatcher points to.
  300. ;
  301.  
  302. ;  Constants for Refcon in AEResumeTheCurrentEvent with kAEUseStandardDispatch 
  303.  
  304. kAEDoNotIgnoreHandler            EQU        $00000000
  305. kAEIgnoreAppPhacHandler            EQU        $00000001            ; available only in vers 1.0.1 and greater 
  306. kAEIgnoreAppEventHandler        EQU        $00000002            ; available only in vers 1.0.1 and greater 
  307. kAEIgnoreSysPhacHandler            EQU        $00000004            ; available only in vers 1.0.1 and greater 
  308. kAEIgnoreSysEventHandler        EQU        $00000008            ; available only in vers 1.0.1 and greater 
  309. kAEIngoreBuiltInEventHandler    EQU        $00000010            ; available only in vers 1.0.1 and greater 
  310. kAEDontDisposeOnResume            EQU        $80000000            ; available only in vers 1.0.1 and greater 
  311. ;  Constants for AEResumeTheCurrentEvent 
  312.  
  313. kAENoDispatch                    EQU        0                    ; dispatch parameter to AEResumeTheCurrentEvent takes a pointer to a dispatch 
  314. kAEUseStandardDispatch            EQU        $FFFFFFFF            ; table, or one of these two constants 
  315. ;
  316. ; pascal OSErr AEResumeTheCurrentEvent(const AppleEvent *theAppleEvent, const AppleEvent *reply, AEEventHandlerUPP dispatcher, long handlerRefcon)
  317. ;
  318.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  319.         Macro
  320.         _AEResumeTheCurrentEvent
  321.             move.w              #$0818,D0
  322.             dc.w                $A816
  323.         EndM
  324.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  325.         IMPORT_CFM_FUNCTION AEResumeTheCurrentEvent
  326.     ENDIF
  327.  
  328. ;
  329. ; pascal OSErr AEGetTheCurrentEvent(AppleEvent *theAppleEvent)
  330. ;
  331.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  332.         Macro
  333.         _AEGetTheCurrentEvent
  334.             move.w              #$021A,D0
  335.             dc.w                $A816
  336.         EndM
  337.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  338.         IMPORT_CFM_FUNCTION AEGetTheCurrentEvent
  339.     ENDIF
  340.  
  341. ;
  342. ; pascal OSErr AESetTheCurrentEvent(const AppleEvent *theAppleEvent)
  343. ;
  344.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  345.         Macro
  346.         _AESetTheCurrentEvent
  347.             move.w              #$022C,D0
  348.             dc.w                $A816
  349.         EndM
  350.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  351.         IMPORT_CFM_FUNCTION AESetTheCurrentEvent
  352.     ENDIF
  353.  
  354.  
  355. ; **************************************************************************
  356. ;  These calls are used to set up and modify special hooks into the
  357. ;  AppleEvent manager.
  358. ;*************************************************************************
  359.  
  360. ;
  361. ; pascal OSErr AEInstallSpecialHandler(AEKeyword functionClass, UniversalProcPtr handler, Boolean isSysHandler)
  362. ;
  363.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  364.         Macro
  365.         _AEInstallSpecialHandler
  366.             move.w              #$0500,D0
  367.             dc.w                $A816
  368.         EndM
  369.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  370.         IMPORT_CFM_FUNCTION AEInstallSpecialHandler
  371.     ENDIF
  372.  
  373. ;
  374. ; pascal OSErr AERemoveSpecialHandler(AEKeyword functionClass, UniversalProcPtr handler, Boolean isSysHandler)
  375. ;
  376.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  377.         Macro
  378.         _AERemoveSpecialHandler
  379.             move.w              #$0501,D0
  380.             dc.w                $A816
  381.         EndM
  382.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  383.         IMPORT_CFM_FUNCTION AERemoveSpecialHandler
  384.     ENDIF
  385.  
  386. ;
  387. ; pascal OSErr AEGetSpecialHandler(AEKeyword functionClass, UniversalProcPtr *handler, Boolean isSysHandler)
  388. ;
  389.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  390.         Macro
  391.         _AEGetSpecialHandler
  392.             move.w              #$052D,D0
  393.             dc.w                $A816
  394.         EndM
  395.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  396.         IMPORT_CFM_FUNCTION AEGetSpecialHandler
  397.     ENDIF
  398.  
  399.  
  400. ; **************************************************************************
  401. ;  This call was added in version 1.0.1. If called with the keyword
  402. ;  keyAERecorderCount ('recr'), the number of recorders that are
  403. ;  currently active is returned in 'result'
  404. ;  (available only in vers 1.0.1 and greater).
  405. ;*************************************************************************
  406.  
  407. ;
  408. ; pascal OSErr AEManagerInfo(AEKeyword keyWord, long *result)
  409. ;
  410.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  411.         Macro
  412.         _AEManagerInfo
  413.             move.w              #$0441,D0
  414.             dc.w                $A816
  415.         EndM
  416.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  417.         IMPORT_CFM_FUNCTION AEManagerInfo
  418.     ENDIF
  419.  
  420.  
  421.  
  422.     ENDIF ; __APPLEEVENTS__ 
  423.  
  424.